﻿using System;
using System.Collections.Generic;

using RoughJs.Error;

namespace RoughJs.Ast
{
    /// <summary>
    /// 2010-01-5 ----- 2010-01-29
    /// 陈曦 1.0
    /// Microsoft Public License (Ms-PL)
    ///This license governs use of the accompanying software. If you use the software, you accept this license. If you do not accept the license, do not use the software.
    ///1. Definitions
    ///The terms "reproduce," "reproduction," "derivative works," and "distribution" have the same meaning here as under U.S. copyright law.
    ///A "contribution" is the original software, or any additions or changes to the software.
    ///A "contributor" is any person that distributes its contribution under this license.
    ///"Licensed patents" are a contributor's patent claims that read directly on its contribution.
    ///2. Grant of Rights
    ///(A) Copyright Grant- Subject to the terms of this license, including the license conditions and limitations in section 3, each contributor grants you a non-exclusive, worldwide, royalty-free copyright license to reproduce its contribution, prepare derivative works of its contribution, and distribute its contribution or any derivative works that you create.
    ///(B) Patent Grant- Subject to the terms of this license, including the license conditions and limitations in section 3, each contributor grants you a non-exclusive, worldwide, royalty-free license under its licensed patents to make, have made, use, sell, offer for sale, import, and/or otherwise dispose of its contribution in the software or derivative works of the contribution in the software.
    ///3. Conditions and Limitations
    ///(A) No Trademark License- This license does not grant you rights to use any contributors' name, logo, or trademarks.
    ///(B) If you bring a patent claim against any contributor over patents that you claim are infringed by the software, your patent license from such contributor to the software ends automatically.
    ///(C) If you distribute any portion of the software, you must retain all copyright, patent, trademark, and attribution notices that are present in the software.
    ///(D) If you distribute any portion of the software in source code form, you may do so only under this license by including a complete copy of this license with your distribution. If you distribute any portion of the software in compiled or object code form, you may only do so under a license that complies with this license.
    ///(E) The software is licensed "as-is." You bear the risk of using it. The contributors give no express warranties, guarantees or conditions. You may have additional consumer rights under your local laws which this license cannot change. To the extent permitted under your local laws, the contributors exclude the implied warranties of merchantability, fitness for a particular purpose and non-infringement. 
    /// 
    /// 抽象机
    /// </summary>
    public interface Evaluator 
    {
        
       /// <summary>
       /// 编译脚本或者方法为中间形式
       /// </summary>
       /// <param name="compilerEnv">编译环境</param>
       /// <param name="tree">树</param>
       /// <param name="encodedSource">源代码</param>
       /// <param name="returnFunction">是否需要返回的方法</param>
       /// <returns></returns>
         Object compile(CompilerEnvirons compilerEnv,
                          ScriptOrFnNode tree,
                          String encodedSource,
                          bool returnFunction);

    /// <summary>
    /// 创建方法对象
    /// </summary>
    /// <param name="cx">当前上下文</param>
    /// <param name="scope">方法所在的域</param>
    /// <param name="bytecode">字节码</param>
    /// <param name="staticSecurityDomain">安全域</param>
    /// <returns></returns>
         Function createFunctionObject(Context cx, Scriptable scope,
                Object bytecode, Object staticSecurityDomain);

       /// <summary>
       /// 创建脚本对象
       /// </summary>
       /// <param name="bytecode">字节码</param>
       /// <param name="staticSecurityDomain">安全域</param>
       /// <returns></returns>
         Script createScriptObject(Object bytecode,
                                         Object staticSecurityDomain);

        /// <summary>
        /// 捕获堆栈信息
        /// </summary>
        /// <param name="ex"></param>
         void captureStackInfo(RhinoException ex);

        /// <summary>
        /// 从栈得到源信息
        /// </summary>
        /// <param name="cx"></param>
        /// <param name="linep"></param>
        /// <returns></returns>
         String getSourcePositionFromStack(Context cx, int[] linep);

        /// <summary>
        /// 得到本地的异常的跟踪信息
        /// </summary>
        /// <param name="ex"></param>
        /// <param name="nativeStackTrace"></param>
        /// <returns></returns>
         String getPatchedStack(RhinoException ex,
                                      String nativeStackTrace);

        /// <summary>
        /// 从异常中得到栈信息
        /// </summary>
        /// <param name="ex"></param>
        /// <returns></returns>
         List<String> getScriptStack(RhinoException ex);

        /// <summary>
        /// 标记一个脚本被eval()创建或者是构造方法
        /// </summary>
        /// <param name="script"></param>
         void setEvalScriptFlag(Script script);
    }
}
